home *** CD-ROM | disk | FTP | other *** search
/ System Booster / System Booster.iso / Screenblankers / Spliner / Spliner.doc < prev    next >
Text File  |  1996-09-26  |  8KB  |  202 lines
  1.  
  2.  
  3. *
  4.  
  5.    This document describes `Spliner' 1.17, a freeware spline screen
  6. blanker commodity for the Amiga.
  7.  
  8.    Copyright © 1991,1992 Tom Rokicki and Sebastiano Vigna
  9.  
  10.  
  11. The birth of `Spliner'
  12. ***********************
  13.  
  14.    Tom Rokicki's `Mackie' is one of the most well-known and most
  15. beautiful utilities for the Amiga. It has two separate functionalities:
  16. it's a blanker which draws wonderful splines, and a powerful hot-key
  17. manager.
  18.  
  19.    What I did was taking out the spline code from the original `Mackie'
  20. sources and encapsulate it in a standard Commodity (of course, this
  21. means someone else will have to port the hot-key part...).
  22.  
  23.    Commodities are the new way, designed by Commodore, by which all
  24. special utilities like mouse accelerators, macro expanders etc. should
  25. be designed. This standard, available *only* under Release 2 and
  26. higher, allows easy and customizable control of the interaction of
  27. different utilities. This means, of course, that `Spliner' will work
  28. only under version 2.04 or higher.
  29.  
  30.    In the process of moving to 2.04, some new features were added,
  31. namely programmable pattern change timeout, and the possibily to open
  32. the blank screen in *any* of the modes available on your Amiga.
  33.  
  34.    For the generic use of a Commodity, please refer to the 2.0 manual.
  35. `Spliner' will (more or less) work just like the screen blanker
  36. supplied on the Workbench 2.04 disk.
  37.  
  38.  
  39. Gadgets
  40. ********
  41.  
  42.    If you activate `Spliner' by double-clicking on its icon, you will
  43. see a window popping up. The detailed list of the available gadgets
  44. follows:
  45.  
  46. HIDE
  47. QUIT
  48.      work exactly like in Commodore's blanker.
  49.  
  50. TIMEOUT
  51.      lets you set the number of seconds after which the screen is
  52.      blanked; defaults to 60.
  53.  
  54. CHANGE
  55.      lets you set the time after which the drawing pattern is changed:
  56.      set this to zero to go psychedelic 8^); defaults to 60.
  57.  
  58. CHECK
  59. THRESHOLD
  60.      set the auto-disabling of spline drawing under heavy CPU load. If
  61.      CHECK is nonzero, every CHECK seconds a high priority task checks
  62.      if at least THRESHOLD lines were drawn from the last check. If
  63.      this doesn't happen, the screen is completely blanked (no
  64.      splines). This feature saves your screen when some CPU-intensive
  65.      task (e.g., 3D rendering) is stealing all the CPU power so that
  66.      `Spliner' can't draw and a fixed pattern appears on the screen. As
  67.      soon as more CPU time is available, `Spliner' will restart to
  68.      cycle colors. Moreover, each CHECK seconds `Spliner' re-blanks the
  69.      mouse and `ScreenToFront()'s its screen. If you set CHECK to 0, the
  70.      control task is not set up, thus gaining about 1K of memory. CHECK
  71.      and THRESHOLD default to 8.
  72.  
  73. CYCLE COLORS
  74.      allows you to enable/disable the color cycling (mainly for special
  75.      screen modes such as 2024_10Hz).
  76.  
  77. DMA OFF
  78.      enables the DMA disabling. When DMA OFF is selected, instead of
  79.      drawing splines `Spliner' will simply turn off the video DMA. This
  80.      mode is not particularly nice to see, but frees the Chip bus from
  81.      every DMA video access usage. This can have a certain impact on
  82.      computationally intensive programs, in particular on a machine
  83.      which has only Chip RAM. If, for instance, you're doing ray
  84.      tracing on an A600, turning off DMA could really give you an edge.
  85.      See Important Notice.
  86.  
  87. COLOR
  88.      allows you to select a specific color to use for spline drawing
  89.      when cycling is disabled. The format is a bit rude, i.e.,
  90.      R*256+G*16+B, where R,G and B are the four-bit components of the
  91.      color. For instance, 4095 is pure white, while 15 is pure blue.
  92.  
  93. IMMEDIATE EFFECT
  94.      blanks immediately (after 1 second) the screen (this feature was
  95.      coded by Jean-Michel Bezeau).
  96.  
  97.    The list displayed on the right represents all video modes installed
  98. on your system. This list could also include some modes that aren't
  99. really displayable on your Amiga, but no harm can be done. You can
  100. click on any display mode in order to force Spliner to use that kind of
  101. display when blanking the screen.
  102.  
  103.    Everything that can be selected by a gadget can also be configured
  104. by a tooltypes. See Tooltypes.
  105.  
  106.  
  107. Tooltypes
  108. **********
  109.  
  110.    There are five extra tooltypes: `TIMEOUT', `CHANGE', `CHECK',
  111. `THRESHOLD', `DISPLAY', `CYCLE', `DMA', `COLOR' and `BLANK'. The first
  112. six act just like the corresponding gadgets (see Gadgets). Note that
  113. the name you set `DISPLAY' to must be an exact copy of the name
  114. appearing in the window list (up to lower/upper casing). For instance,
  115. `DISPLAY=PAL:Lores-Interlaced' (note that on localized machine, the
  116. name has to be written in the localization language). If you have a PAL
  117. (resp. NTSC) Amiga and you have a real MultiSync monitor, you can even
  118. add the NTSC (resp. PAL) monitor to your system and open the blank
  119. screen with another video frequency! This has no usefulness at all, but
  120. it's amusing. The `CYCLE' and `DMA' tooltypes can of course be set to
  121. `ON' or `OFF'.
  122.  
  123.    `BLANK' lets you specify an hotkey (in the same format as
  124. `CX_POPKEY') which will immediately (after 1 second) blank the screen,
  125. just like the IMMEDIATE EFFECT gadget (the delay is necessary because
  126. otherwise the input event caused by the hotkey would unblank the
  127. screen).
  128.  
  129.    In order to start `Spliner' at power-up, the best thing is to move
  130. its icon into the `WBStartup' drawer, and to set its tooltypes to the
  131. desired values. Don't forget to add the `DONOTWAIT' tooltype, too.
  132. You'd probably also want to set `CX_POPUP=NO'. Another thing to
  133. consider is that since `Spliner' reads the display modes in the
  134. graphical database, you must be sure `Mode_Names' is ran before it. In
  135. order to obtain this, you should add the tooltype `STARTPRI=-120'.
  136.  
  137.  
  138. Important Notice
  139. *****************
  140.  
  141.    Some people think that terrific blankers steal CPU time. This is not
  142. the case with `Spliner'. If a task is using the CPU, `Spliner' will
  143. stop drawing. If in particular your application has a hi-res
  144. multi-color screen, the presence of the blank screen will actually
  145. speed up whatever the Amiga is doing, by lessening the DMA contention.
  146. If, moreover, you select the DMA off switch (see Gadgets), you will
  147. definitely gain in speed, but you won't have a terrific blanker any
  148. longer.
  149.  
  150.  
  151. Changes
  152. ********
  153.  
  154.    From revision 37.8, the mouse is blanked "legally" by opening a
  155. window on the blank screen and using `SetPointer()'. This means that
  156. when the blanker starts the current active window will be deactivated.
  157. This shouldn't however have any side-effect.
  158.  
  159.    From revision 37.12, there is an `About...' menu item, and the
  160. copyright notice is no longer in the window title. The CHECK/THRESHOLD
  161. control were introduced, and the user interface was made
  162. font-sensitive. A comprehensive optimization greatly reduced the CPU
  163. time used while checking the input events (i.e., while the screen is
  164. not blanked). Finally, an important bug fix (the window could have been
  165. closed without `GT_ReplyIMsg()'ing all pending IntuiMessages).
  166.  
  167.    Revision 37.15 fixes a stupid bug (not enough stack size) which was
  168. really difficult to reproduce. Thanks to Alessandro Pelosi at Agemo for
  169. his precise report, and to Martin Taillefer at Commodore for his
  170. precious suggestions: with the new mouse blanking code, Spliner doesn't
  171. deactivate the current window any longer, and in particular it doesn't
  172. deactivate gadgets.
  173.  
  174.    Revision 37.17 introduces the COLOR and DMA switches and support for
  175. some V39 features (like new look menus).
  176.  
  177.  
  178. Disclaimer and Author Info
  179. ***************************
  180.  
  181.    `Spliner' is Copyright (C) 1991,1992 Tom Rokicki and Sebastiano
  182. Vigna and it's freely distributable as long as all of its files are
  183. included in their original form without additions, deletions, or
  184. modifications of any kind, and only a nominal fee is charged for its
  185. distribution. This software is provided *AS IS* without warranty of any
  186. kind, either expressed or implied. By using `Spliner', you agree to
  187. accept the entire risk as to the quality and performance of the program.
  188.  
  189.    Comments, complaints, desiderata are welcome.
  190.  
  191.          Sebastiano Vigna
  192.          Via California 22
  193.          I-20144 Milano MI
  194.      
  195.          BIX: svigna
  196.          INTERNET: vigna@imiucca.csi.unimi.it
  197.                    vigna@ghost.sm.dsi.unimi.it
  198.          UUCP:cbmehq!cbmita!sebamiga!seba@cbmvax.cbm.commodore.com
  199.               ...{uunet|pyramid|rutgers}!cbmvax!cbmehq!cbmita!sebamiga!seba
  200.          FIDO: 2:332/607.28
  201.  
  202.